<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>Xmla.Dataset.Axis</title>
    <link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.5.1&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
    <link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
    <link rel="shortcut icon" type="image/png" href="..&#x2F;assets/favicon.png">
    <script src="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;combo?3.5.1&#x2F;build&#x2F;yui&#x2F;yui-min.js"></script>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
            
                <h1><img src="..&#x2F;assets/css/logo.png" title=""></h1>
            
        </div>
        <div class="yui3-u-1-4 version">
            <em>API Docs for: </em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
    <h2 class="off-left">APIs</h2>
    <div id="api-tabview" class="tabview">
        <ul class="tabs">
            <li><a href="#api-classes">Classes</a></li>
            <li><a href="#api-modules">Modules</a></li>
        </ul>

        <div id="api-tabview-filter">
            <input type="search" id="api-filter" placeholder="Type to filter APIs">
        </div>

        <div id="api-tabview-panel">
            <ul id="api-classes" class="apis classes">
            
                <li><a href="..&#x2F;classes/Xmla.html">Xmla</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Dataset.html">Xmla.Dataset</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Dataset.Axis.html">Xmla.Dataset.Axis</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Dataset.Cellset.html">Xmla.Dataset.Cellset</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Exception.html">Xmla.Exception</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Rowset.html">Xmla.Rowset</a></li>
            
            </ul>

            <ul id="api-modules" class="apis modules">
            
                <li><a href="..&#x2F;modules/xmla.html">xmla</a></li>
            
            </ul>
        </div>
    </div>
</div>

            </div>
        </div>
        <div class="yui3-u-3-4">
                <div id="api-options">
        Show:
        <label for="api-show-inherited">
            <input type="checkbox" id="api-show-inherited" checked>
            Inherited
        </label>

        <label for="api-show-protected">
            <input type="checkbox" id="api-show-protected">
            Protected
        </label>

        <label for="api-show-private">
            <input type="checkbox" id="api-show-private">
            Private
        </label>
        <label for="api-show-deprecated">
            <input type="checkbox" id="api-show-deprecated">
            Deprecated
        </label>

    </div>


            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
                        <h1>Xmla.Dataset.Axis Class</h1>
<div class="box meta">
    

    

    
        <div class="foundat">
            Defined in: <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5877"><code>src&#x2F;Xmla.js:5877</code></a>
        </div>
    

    
        
            Module: <a href="../modules/xmla.html">xmla</a>
        
    

    
</div>



<div class="box intro">
    <p>
This class implements an Axis object.
</p>

<p><p>
You do not need to instantiate objects of this class yourself.
Rather, the <code><a href="Xmla.Dataset.html#class_Xmla.Dataset">Xmla.Dataset</a></code> class creates instances of this class to represent the axes of an MDX query.
(see <code><a href="Xmla.Dataset.html#method_getAxis">getAxis()</a></code>.)</p>
</div>


    <div class="constructor">
        <h2>Constructor</h2>
        <div id="method_Xmla.Dataset.Axis" class="method item">
    <h3 class="name"><code>Xmla.Dataset.Axis</code></h3>

    
        <span class="paren">()</span>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5877"><code>src&#x2F;Xmla.js:5877</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    

    

    
</div>

    </div>


<div id="classdocs" class="tabview">
    <ul class="api-class-tabs">
        <li class="api-class-tab index"><a href="#index">Index</a></li>

        
            <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
        
        
        
        
    </ul>

    <div>
        <div id="index" class="api-class-tabpanel index">
            <h2 class="off-left">Item Index</h2>

            
                <div class="index-section methods">
                    <h3>Methods</h3>

                    <ul class="index-list methods">
                        
                            <li class="index-item method">
                                <a href="#method_eachHierarchy">eachHierarchy</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_eachTuple">eachTuple</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_fetchAllAsArray">fetchAllAsArray</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_fetchAllAsObject">fetchAllAsObject</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_fetchAsArray">fetchAsArray</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_fetchAsObject">fetchAsObject</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getHierarchies">getHierarchies</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getHierarchyNames">getHierarchyNames</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getTuple">getTuple</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hasMoreHierarchies">hasMoreHierarchies</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hasMoreTuples">hasMoreTuples</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hierarchy">hierarchy</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hierarchyCount">hierarchyCount</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hierarchyIndex">hierarchyIndex</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hierarchyName">hierarchyName</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_member">member</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_nextHierarchy">nextHierarchy</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_nextTuple">nextTuple</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_readAsArray">readAsArray</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_readAsObject">readAsObject</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_reset">reset</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_tupleCount">tupleCount</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_tupleIndex">tupleIndex</a>

                                
                                
                            </li>
                        
                    </ul>
                </div>
            

            

            

            
        </div>

        
            <div id="methods" class="api-class-tabpanel">
                <h2 class="off-left">Methods</h2>

                
                    <div id="method_eachHierarchy" class="method item">
    <h3 class="name"><code>eachHierarchy</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>callback.</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>scope.</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>args.</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5992"><code>src&#x2F;Xmla.js:5992</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Calls a callback function for each hierarchy in this Axis object.</p>

<p>The callback function is passed an object that represents the current hierarchy. This object has the following structure:</p><ul>
  <li><code>index</code> <code>int</code> The ordinal identifying this hierarchy</li>
  <li><code>name</code> <code>string</code> The name of this hierarchy</li>
</ul>
<p>The callback may return <code>false</code> to abort iteration. If the callback does not return <code>false</code>, iteration will resume until all hierarchies are traversed.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">callback.</code>
                        <span class="type">Function()</span>
                    

                    

                    <div class="param-description">
                        <p>A function that will be called for each hierarchy. The hierarchy is passed as an object as the first argument to the callback.</p>
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">scope.</code>
                        <span class="type">Object</span>
                    

                    

                    <div class="param-description">
                        <p>The object that will be used as scope when executing the callback function. If this is undefined or <code>null</code>, the Axis' <code>this</code> pointer will be used.</p>
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">args.</code>
                        <span class="type">Object</span>
                    

                    

                    <div class="param-description">
                        <p>Additional data to be passed to the callback function..</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                    Returns <code>true</code> if all hierarchies were visited and the callback did not return <code>false</code>. Returns <code>false</code> if the callback returned <code>false</code> and further iteration was aborted.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_eachTuple" class="method item">
    <h3 class="name"><code>eachTuple</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>callback.</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>scope.</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>args.</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6079"><code>src&#x2F;Xmla.js:6079</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Calls a callback function for each tuple in this Axis object.</p>

<p>The callback function is passed an object that represents the current tuple. (see <code><a href="#method_getTuple">getTuple()</a></code> for a description of the tuple format.)</p>

<p>The callback may return <code>false</code> to abort iteration. If the callback does not return <code>false</code>, iteration will resume until all tuples are traversed.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">callback.</code>
                        <span class="type">Function()</span>
                    

                    

                    <div class="param-description">
                        <p>A function that will be called for each tuple. The tuple is passed as an object as the first argument to the callback.</p>
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">scope.</code>
                        <span class="type">Object</span>
                    

                    

                    <div class="param-description">
                        <p>The object that will be used as scope when executing the callback function. If this is undefined or <code>null</code>, the Axis' <code>this</code> pointer will be used.</p>
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">args.</code>
                        <span class="type">Object</span>
                    

                    

                    <div class="param-description">
                        <p>Additional data to be passed as the second argument to the callback function.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                    Returns <code>true</code> if all tuples were visited and the callback did not return <code>false</code>. Returns <code>false</code> if the callback returned <code>false</code> and further iteration was aborted.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_fetchAllAsArray" class="method item">
    <h3 class="name"><code>fetchAllAsArray</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>rows</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">[array]</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6327"><code>src&#x2F;Xmla.js:6327</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Fetches all tuples and returns them as an array of arrays.
Each element of the returned array is an array of member objects.
For a description of the structure of the member elements, see <code><a href="#method_member">member()</a></code>.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">rows</code>
                        <span class="type">Array</span>
                    

                    

                    <div class="param-description">
                        <p>An existing array to store the tuples in. If omitted, a new array is returned.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">[array]</span>:
                    
                    An array of arrays representing all tuples that belong to this axis.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_fetchAllAsObject" class="method item">
    <h3 class="name"><code>fetchAllAsObject</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>rows</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">[object]</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6341"><code>src&#x2F;Xmla.js:6341</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Fetches all tuples and returns them as an array of objects.
Each element of the returned array is a tuple object.
The object's keys are the hierarchy names, and the members of the current tuple are used as values for the keys.
For a description of the structure of the member elements, see <code><a href="#method_member">member()</a></code>.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">rows</code>
                        <span class="type">Array</span>
                    

                    

                    <div class="param-description">
                        <p>An existing array to store the tuples in. If omitted, a new array is returned.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">[object]</span>:
                    
                    An array of arrays representing all tuples that belong to this axis.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_fetchAsArray" class="method item">
    <h3 class="name"><code>fetchAsArray</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>array</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Array | False</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6296"><code>src&#x2F;Xmla.js:6296</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Gets the current tuple as an array of members and advances the internal tuple pointer.
For a description of the structure of the member elements, see <code><a href="#method_member">member()</a></code>.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">array</code>
                        <span class="type">Array</span>
                    

                    

                    <div class="param-description">
                        <p>An existing array to store the members in. If omitted, a new array is returned.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Array | False</span>:
                    
                    An array of members that represents the current tuple, or <code>false</code> if there are no more tuples.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_fetchAsObject" class="method item">
    <h3 class="name"><code>fetchAsObject</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>object</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Object</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6311"><code>src&#x2F;Xmla.js:6311</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Gets the current tuple as an object and advances the current tuple pointer.
The object's keys are the hierarchy names, and the members of the current tuple are used as values for the keys.
For a description of the structure of the member elements, see <code><a href="#method_member">member()</a></code>.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">object</code>
                        <span class="type">Object</span>
                    

                    

                    <div class="param-description">
                        <p>An existing object to store the tuple data in. If omitted, a new object is returned.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Object</span>:
                    
                    An object that represents the current tuple.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getHierarchies" class="method item">
    <h3 class="name"><code>getHierarchies</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Array</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6105"><code>src&#x2F;Xmla.js:6105</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns the hierarchies of this Axis object.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Array</span>:
                    
                    An array of hierarchies contained in this Axis.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getHierarchyNames" class="method item">
    <h3 class="name"><code>getHierarchyNames</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Array</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6113"><code>src&#x2F;Xmla.js:6113</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns the names of the hierarchies of this Axis object.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Array</span>:
                    
                    An array of names of the hierarchies contained in this Axis.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getTuple" class="method item">
    <h3 class="name"><code>getTuple</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Object</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6058"><code>src&#x2F;Xmla.js:6058</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the current tuple as an object. The tuple object has the following structure: <ul>
    <li><code>index</code> <code>int</code>: the ordinal of this tuple within its axis</li>
    <li><code>hierarchies</code> <code>object</code>: A map of members using hierarchy names as keys, and member objects as values</li>
    <li><code>members</code> <code>array</code>: An array of members in order of hierarchy order.</li>
</ul></p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Object</span>:
                    
                    An object representing the current tuple..
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hasMoreHierarchies" class="method item">
    <h3 class="name"><code>hasMoreHierarchies</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5972"><code>src&#x2F;Xmla.js:5972</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Checks if there are more hierarchies to iterate through.
You can use this method along with the <code><a href="#method_nextHierarchy">nextHierarchy()</a></code> method to drive a loop
to iterate through the hierarchies contained in this axis object.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                    Returns <code>true</code> if there are more hierarchies to vist, <code>false</code> if all hierarchies are traversed.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hasMoreTuples" class="method item">
    <h3 class="name"><code>hasMoreTuples</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6020"><code>src&#x2F;Xmla.js:6020</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Checks if there are more tuples to iterate through.
You can use this method along with the <code><a href="#method_nextTuple">nextTuple()</a></code> method to drive a loop
to iterate through the tuples contained in this axis object.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                    Returns <code>true</code> if there are more tuples to vist, <code>false</code> if all tuples are traversed.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hierarchy" class="method item">
    <h3 class="name"><code>hierarchy</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>hierarchyIndexOrName</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">String</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6166"><code>src&#x2F;Xmla.js:6166</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Gets the hierarchy identified by the specified index or hierarchyName, or the current hierarchy (in case the argument is omitted).</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">hierarchyIndexOrName</code>
                        <span class="type">Int | String</span>
                    

                    

                    <div class="param-description">
                        <p>The ordinal or name of the hierarchy that is to be retrieved. When omitted, the the current hierarchy is returned.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">String</span>:
                    
                    The hierarchy specified by the argument index or name, or the current hierarchy if the argument is omitted.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hierarchyCount" class="method item">
    <h3 class="name"><code>hierarchyCount</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Int</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6123"><code>src&#x2F;Xmla.js:6123</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Gets the number of hierarchies in this axis object.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Int</span>:
                    
                    Returns the number of hierarchies in this Axis object.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hierarchyIndex" class="method item">
    <h3 class="name"><code>hierarchyIndex</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>hierarchyName</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Int</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6131"><code>src&#x2F;Xmla.js:6131</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Gets the index of the hierarchy identified by the specified name, or the index of the current hierarchy (in case the name argument is omitted).</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">hierarchyName</code>
                        <span class="type">String</span>
                    

                    

                    <div class="param-description">
                        <p>The name of the hierarchy for which the index is to be retrieved. When omitted, the index of the current hierarchy is returned.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Int</span>:
                    
                    The index of the hierarchy specified by the name passed as argument, or the index of the current hierarchy if the name argument is omitted.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hierarchyName" class="method item">
    <h3 class="name"><code>hierarchyName</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>hierarchyIndex</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">String</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6148"><code>src&#x2F;Xmla.js:6148</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Gets the name of the hierarchy identified by the specified index, or the name of the current hierarchy (in case the index argument is omitted).</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">hierarchyIndex</code>
                        <span class="type">Int</span>
                    

                    

                    <div class="param-description">
                        <p>The ordinal of the hierarchy for which the name is to be retrieved. When omitted, the name of the current hierarchy is returned.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">String</span>:
                    
                    The name of the hierarchy specified by the argument index, or the name of the current hierarchy if the index argument is omitted.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_member" class="method item">
    <h3 class="name"><code>member</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>hierarchyIndexOrName</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Object</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6196"><code>src&#x2F;Xmla.js:6196</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Gets the member for the specified hierarchy from the current tuple. The member has the following structure: <ul>
  <li><code>index</code> - <code>int</code></li>
  <li><code>hierarchy</code> - <code>string</code>. Name of the hiearchy to which this member belongs.</li>
  <li><code>UName</code> - <code>string</code>. Unique name of this member.</li>
  <li><code>Caption</code> - <code>string</code>. Human friendly name for this member.</li>
  <li><code>LName</code> - <code>string</code>. Name of the level to which this member belongs.</li>
  <li><code>LNum</code> - <code>int</code>. Number of the level to which this member belongs. Typically, the top-level is level 0, its children are level 1 and so on.</li>
  <li><code>DisplayInfo</code> - <code>int</code>.</li>
</ul></p>

<p>
The <code>index</code> and <code>hierarchy</code> properties are non standard and always added by Xmla4js.
The properties <code>UName</code>, <code>Caption</code>, <code>LName</code> and <code>LNum</code> are defined by the XML/A standard, and should always be present.
The property <code>DisplayInfo</code> is non-standard, but often available.
Other properties may be present depending on the specific XML/A provider.
</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">hierarchyIndexOrName</code>
                        <span class="type">Int | String</span>
                    

                    

                    <div class="param-description">
                        <p>The ordinal or name of the hierarchy from which the member is to be retrieved. When omitted, the the current hierarchy is returned.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Object</span>:
                    
                    The member of the current tuple that belongs to the specified hierarchy, If the argument is omitted the member that belongs current hierarchy is retrieved from the current tuple.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_nextHierarchy" class="method item">
    <h3 class="name"><code>nextHierarchy</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Int</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5982"><code>src&#x2F;Xmla.js:5982</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Moves the internal hierarchy pointer forward.
You can use this method along with the <code><a href="#method_hasMoreHierarchies">hasMoreHierarchies()</a></code> method to drive a loop
to iterate through the hierarchies contained in this axis object.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Int</span>:
                    
                    Returns the index of current hierarchy.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_nextTuple" class="method item">
    <h3 class="name"><code>nextTuple</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Int</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6030"><code>src&#x2F;Xmla.js:6030</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Moves the internal tuple pointer forward.
You can use this method along with the <code><a href="#method_nextTuple">nextTuple()</a></code> method to drive a loop
to iterate through the tuples contained in this axis object.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Int</span>:
                    
                    Returns the index of current tuple.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_readAsArray" class="method item">
    <h3 class="name"><code>readAsArray</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>array</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Array</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6269"><code>src&#x2F;Xmla.js:6269</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Gets the current tuple as an array of members.
For a description of the structure of the member elements, see <code><a href="#method_member">member()</a></code>.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">array</code>
                        <span class="type">Array</span>
                    

                    

                    <div class="param-description">
                        <p>An existing array to store the members in. If omitted, a new array is returned.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Array</span>:
                    
                    An array of members that represents the current tuple.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_readAsObject" class="method item">
    <h3 class="name"><code>readAsObject</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>object</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Object</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6282"><code>src&#x2F;Xmla.js:6282</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Gets the current tuple as an object.
The object's keys are the hierarchy names, and the members of the current tuple are used as values for the keys.
For a description of the structure of the member elements, see <code><a href="#method_member">member()</a></code>.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">object</code>
                        <span class="type">Object</span>
                    

                    

                    <div class="param-description">
                        <p>An existing object to store the tuple data in. If omitted, a new object is returned.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Object</span>:
                    
                    An object that represents the current tuple.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_reset" class="method item">
    <h3 class="name"><code>reset</code></h3>

    
        <span class="paren">()</span>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5961"><code>src&#x2F;Xmla.js:5961</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Resets this axis object.
This resets internal counters for iterating through the hierarchies and tuples of this Axis object.
When using hierarchy and tuple iterators to traverse the entire axis, you typically won't need to call this method yourself.</p>
    </div>

    

    

    
</div>

                
                    <div id="method_tupleCount" class="method item">
    <h3 class="name"><code>tupleCount</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Int</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6042"><code>src&#x2F;Xmla.js:6042</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Gets the number of tuples in this axis object.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Int</span>:
                    
                    Returns the number of tuples in this Axis object.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_tupleIndex" class="method item">
    <h3 class="name"><code>tupleIndex</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Int</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6050"><code>src&#x2F;Xmla.js:6050</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns the current value of the tuple pointer.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Int</span>:
                    
                    Returns the current value of the tuple pointer.
                
            </div>
        </div>
    

    
</div>

                
            </div>
        

        

        

        
    </div>
</div>

                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="..&#x2F;assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="..&#x2F;assets/js/yui-prettify.js"></script>
<script src="..&#x2F;assets/../api.js"></script>
<script src="..&#x2F;assets/js/api-filter.js"></script>
<script src="..&#x2F;assets/js/api-list.js"></script>
<script src="..&#x2F;assets/js/api-search.js"></script>
<script src="..&#x2F;assets/js/apidocs.js"></script>
</body>
</html>
